Access APIs
Access APIs for managing users, roles, tenants and other related system security operations
API Methods
★ Includes Example(s)
◉ Can be used by Non-admin accounts
|
Add new AD LDAP server |
2018.5 |
|
|
|
|
Adds a User Profile |
2020.0 |
★ |
|
|
|
Add a user to a Role |
2018.5 |
★ |
|
|
|
Add Users to a Role |
2018.5 |
|
|
|
|
Change a User’s License Type |
2018.5 |
|
|
|
|
Modify Active Directory Groups in a Role |
2018.5 |
★ |
|
|
|
Create a Security Role |
2018.5 |
★ |
|
|
|
Create Security Roles |
2018.5 |
★ |
|
|
|
Create a Tenant |
2018.5 |
★ |
|
|
|
Create Multiple Tenants |
2018.5 |
|
|
|
|
Create a new user (ACTIVE DIRECTORY) |
2020.10 |
★ |
|
|
|
Create a new user (DATABASE) |
2020.10 |
★ |
|
|
|
Create a new user (OpenID) |
2020.20 |
|
|
|
|
Create a new user (SAML) |
2020.10 |
★ |
|
|
|
Create multiple users (ACTIVE DIRECTORY) |
2020.10 |
|
|
|
|
Create multiple users (Internal / Database) |
2020.10 |
|
|
|
|
Create multiple users (OpenID) |
2020.20 |
|
|
|
|
Create multiple users (SAML) |
2020.10 |
|
|
|
|
Removes a user profile from the system |
2020.0 |
★ |
|
|
|
Delete a Role |
2018.5 |
★ |
|
|
|
Delete Tenants |
2018.5 |
★ |
|
|
|
Delete a User |
2018.5 |
★ |
|
|
|
Get All Public Roles |
2018.5 |
|
|
|
|
Get All Public Roles for a Tenant |
2018.5.2 |
|
|
|
|
Get All Public Roles for a Tenant |
2018.5.2 |
|
|
|
|
Get a list of al user profiles in the System |
2020.0 |
|
|
|
|
Get a list of all user profiles in the system for a specific tenant |
2020.0 |
★ |
|
|
|
Get All Roles |
2018.5 |
|
|
|
|
Returns a list of roles assigned to the specified user profile |
2020.0 |
★ |
|
|
|
Get all Roles for a User |
2018.5 |
|
|
|
|
Get all Tenants |
2018.5 |
|
|
|
|
Get the Current Tenant's Users |
2018.5 |
|
|
|
|
Get a Tenant's Users |
2018.5 |
|
|
|
|
Get a Tenant's Users with specific license type |
2018.5.2 |
★ |
|
|
|
Get Available License Count for a Tenant |
2018.5 |
★ |
|
|
|
Get the default tenant ID |
2018.5 |
★ |
|
|
|
Get Active Directory Groups for a Role |
2018.5 |
★ |
|
|
|
Get Tenant License Count |
2018.5 |
|
|
|
|
Get License Expiration Date |
2018.5 |
|
|
|
|
Get License Status |
2018.5 |
|
|
|
|
Gets details for the current user. |
2020.0 |
★ |
◉ |
|
|
Returns the profile assigned to the specified user |
2020.0 |
|
|
|
|
Get a Security Role by ID |
2018.5 |
|
|
|
|
Find Security Roles |
2018.5 |
★ |
|
|
|
Get Tenant by Name |
2018.5 |
★ |
|
|
|
Get a User via ID |
2018.5 |
|
|
|
|
Get a User by UPN (OpenID) |
2020.20 |
|
|
|
|
Get a User by UPN (SAML) |
2018.5 |
★ |
|
|
|
Get User Last Login Timestamp |
2018.5 |
|
|
|
|
Get User's System Status by User ID |
2018.5 |
★ |
|
|
|
Get User's System Status by Name |
2018.5 |
|
|
|
|
Get a User by UserName |
2018.5 |
★ |
|
|
|
Get all Users in a Role |
2018.5 |
|
|
|
|
Search AD Groups |
2018.5 |
|
|
|
|
Search User’s AD Groups |
2018.5 |
★ |
|
|
|
Search for Active Directory users |
2018.5 |
★ |
|
|
|
Search Active Directory Group Members |
2018.5 |
|
|
|
|
Set User's Administration Level |
2018.5 |
|
|
|
|
Change User's Status |
2018.5 |
|
|
|
|
Update Role Profiles |
2020.0 |
★ |
|
|
|
Updates a tenant seats |
2020.0 |
|
|
|
|
Update user settings (ACTIVE DIRECTORY) |
2020.10 |
★ |
|
|
|
Update user settings (Internal / DATABASE) |
2020.10 |
|
|
|
|
Update user settings (OpenID) |
2020.20 |
|
|
|
|
Update a User’s Roles |
2018.5 |
|
|
|
|
Update user settings (SAML) |
2020.0 |
|
|
|
|
Update user settings (ACTIVE DIRECTORY) |
2020.10 |
★ |
|
|
|
Update user settings (Internal / DATABASE) |
2020.10 |
★ |
|
|
|
Update settings for multiple users (OpenID) |
2020.20 |
|
|
|
|
Update phones of users |
2020.0 |
|
|
|
|
Update settings for multiple users (SAML) |
2018.5 |
★ |
|
addDomainSettings